Skip to content

[docs] Add documentation for custom_handshaker extension point#13083

Merged
mattklein123 merged 6 commits intoenvoyproxy:masterfrom
ambuc:custom-handshaker-docs
Sep 15, 2020
Merged

[docs] Add documentation for custom_handshaker extension point#13083
mattklein123 merged 6 commits intoenvoyproxy:masterfrom
ambuc:custom-handshaker-docs

Conversation

@ambuc
Copy link
Contributor

@ambuc ambuc commented Sep 14, 2020

Signed-off-by: James Buckland jbuckland@google.com

Commit Message: This PR adds some documentation for the custom_handshaker extension point.
Additional Description: n/a
Risk Level: n/a
Testing: n/a
Docs Changes: See this PR.
Release Notes: n/a

@ambuc
[docs] Add documentation for custom_handshaker extension point
be51759 
Signed-off-by: James Buckland <jbuckland@google.com>
@ambuc
Copy link
Contributor Author

ambuc commented Sep 14, 2020

/assign lizan

@ambuc
Copy link
Contributor Author

ambuc commented Sep 14, 2020

NB to reviewers: seeking feedback on how to deep-link namespaced classes into the codebase. I understand how to use :ref: to link to other places in the docs, but not how to link to a symbol in the repo.

@ambuc ambuc mentioned this pull request Sep 14, 2020
Merged
mattklein123
mattklein123 requested changes Sep 14, 2020
View reviewed changes
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this. Can you also add a release note for the feature? Thank you.

/wait

@mattklein123
Copy link
Member

mattklein123 commented Sep 14, 2020

NB to reviewers: seeking feedback on how to deep-link namespaced classes into the codebase. I understand how to use :ref: to link to other places in the docs, but not how to link to a symbol in the repo.

I would use SHA (permalink) based Github links if you want to link to specific code.

@mattklein123 mattklein123 self-assigned this Sep 14, 2020
@ambuc
[docs] More permalinks to github from docs
746846c 
Signed-off-by: James Buckland <jbuckland@google.com>
@ambuc
[docs] Add release note for custom_handshaker field
fe18f80 
Signed-off-by: James Buckland <jbuckland@google.com>
@ambuc ambuc requested a review from mattklein123 September 14, 2020 20:07
@ambuc
[misc] Run fix_format.
d58b616 
Signed-off-by: James Buckland <jbuckland@google.com>
@mattklein123
Copy link
Member

mattklein123 commented Sep 14, 2020

Please check CI. You can build docs locally using docs/build.sh if you want to test.

/wait

@ambuc
[misc] Fix field_extensions/msg_extensions error in docs.
d6e2deb 
Signed-off-by: James Buckland <jbuckland@google.com>
mattklein123
mattklein123 requested changes Sep 15, 2020
View reviewed changes
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the doc improvements, just a few more comments. Thank you!

/wait

@ambuc
[docs] Add more links to ssl architecture and release notes
34d85bc 
Signed-off-by: James Buckland <jbuckland@google.com>
@ambuc ambuc requested a review from mattklein123 September 15, 2020 17:17
mattklein123
mattklein123 approved these changes Sep 15, 2020
View reviewed changes
Copy link
Member

@mattklein123 mattklein123 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@mattklein123 mattklein123 merged commit 4706ee0 into envoyproxy:master Sep 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mattklein123 mattklein123 mattklein123 approved these changes

Assignees

@lizan lizan

@mattklein123 mattklein123

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ambuc @mattklein123 @lizan